AvaTax API
REST interface to Avalara's enterprise tax service, AvaTax.
Retrieve a single account
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
Path Parameters
The ID of the account to retrieve.
Response
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single account now!
Input
API Endpoint
Method
Request
Response
Update a single account
Path Parameters
The ID of the account you wish to update.
Post Body Parameters
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single account now!
Input
API Endpoint
Method
Request
{ "subscriptions": [ {} ], "users": [ {} ] }
Response
Delete a single account
Deleting an account will delete all companies, and all account level users attached to this account.
Path Parameters
The ID of the account you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single account now!
Input
API Endpoint
Method
Request
Response
Retrieve all accounts
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all accounts now!
Input
API Endpoint
Method
Request
Response
Create a new account
Post Body Parameters
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new account now!
Input
API Endpoint
Method
Request
{ "subscriptions": [ {} ], "users": [ {} ] }
Response
Retrieve geolocation information for a specified address
Post Body Parameters
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Response
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Latitude
Longitude
The resolution quality of the geospatial coordinates
Avalara Id
Jurisdiction Name
Jurisdiction Type
Signature Code
Try Retrieve geolocation information for a specified address now!
Input
API Endpoint
Method
Request
{}
Response
Retrieve a single batch
Path Parameters
The ID of the company that owns this batch
The primary key of this batch
Response
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
Try Retrieve a single batch now!
Input
API Endpoint
Method
Request
Response
Update a single batch
Path Parameters
The ID of the company that this batch belongs to.
The ID of the batch you wish to update
Post Body Parameters
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
Response
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
Try Update a single batch now!
Input
API Endpoint
Method
Request
{ "files": [ {} ] }
Response
Delete a single batch
Path Parameters
The ID of the company that owns this batch.
The ID of the batch you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single batch now!
Input
API Endpoint
Method
Request
Response
Retrieve all batches for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these batches
Response
The number of rows returned by your query, prior to pagination.
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
The link to the next page of results
Try Retrieve all batches for this company now!
Input
API Endpoint
Method
Request
Response
Create a new batch
Path Parameters
The ID of the company that owns this batch.
Post Body Parameters[Array]
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
Response[Array]
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
Try Create a new batch now!
Input
API Endpoint
Method
Request
[ { "files": [ {} ] } ]
Response
Retrieve all batches
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
The ID number of this batch
The user-friendly readable name for this batch
The Account ID number of the account that owns this batch
The Company ID number of the company that owns this batch
The type of this batch
This batch's current processing status
Any optional flags provided for this batch
The agent used to create this batch
The date/time when this batch started processing
The number of records in this batch
The current record being processed
The date/time when this batch was completely processed
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Unique BatchFile identifier
BatchId that this BatchFile is associated with.
Logical Name of file (e.g. "Input" or "Error")
BatchFile content
Size of content in bytes
Content mime type (e.g. text/csv). This is used for HTTP downloading.
File extension (e.g. CSV)
Number of errors that occurred when processing this file.
The link to the next page of results
Try Retrieve all batches now!
Input
API Endpoint
Method
Request
Response
Retrieve a single company
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
Path Parameters
The ID of the company to retrieve.
Response
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single company now!
Input
API Endpoint
Method
Request
Response
Update a single company
Path Parameters
The ID of the company you wish to update.
Post Body Parameters
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single company now!
Input
API Endpoint
Method
Request
{ "contacts": [ {} ], "filingCalendars": [ {} ], "items": [ {} ], "locations": [ {} ], "nexus": [ {} ], "settings": [ {} ], "taxCodes": [ {} ], "taxRules": [ {} ], "upcs": [ {} ] }
Response
Delete a single company
Deleting a company will delete all child companies, and all users attached to this company.
Path Parameters
The ID of the company you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single company now!
Input
API Endpoint
Method
Request
Response
Retrieve all companies
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all companies now!
Input
API Endpoint
Method
Request
Response
Create a new company
Post Body Parameters
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new company now!
Input
API Endpoint
Method
Request
{ "contacts": [ {} ], "filingCalendars": [ {} ], "items": [ {} ], "locations": [ {} ], "nexus": [ {} ], "settings": [ {} ], "taxCodes": [ {} ], "taxRules": [ {} ], "upcs": [ {} ] }
Response
Quick setup for a company with a single physical address
Post Body Parameters
Company Name
Company Code - used to distinguish between companies within your accounting system
Vat Registration Id - leave blank if not known.
United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual.
Address Line1
Line2
Line3
City
Region
Postal Code
Country
First Name
Last Name
Title
Phone Number
Mobile Number
Fax Number
Response
Id
Account Id
Parent Company Id
SST Pid
Company Code
Name
Is Default
Default Location Id
Is Active
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Tax Payer Id Number
Has Profile
Is Reporting Entity
SST Effective Date
Entity No
Default Country
Base Currency Code
Rounding Level Id
Cash Basis Accounting Enabled
Warnings Enabled
Is Test
Tax dependency Level Id
In Progress
Business Identification No
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Company Id
Set
Name
Value
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Quick setup for a company with a single physical address now!
Input
API Endpoint
Method
Request
{}
Response
Retrieve a single contact
Path Parameters
The ID of the company that owns this contact
The primary key of this contact
Response
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single contact now!
Input
API Endpoint
Method
Request
Response
Update a single contact
Path Parameters
The ID of the company that this contact belongs to.
The ID of the contact you wish to update
Post Body Parameters
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single contact now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single contact
Path Parameters
The ID of the company that owns this contact.
The ID of the contact you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single contact now!
Input
API Endpoint
Method
Request
Response
Retrieve contacts for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these contacts
Response
The number of rows returned by your query, prior to pagination.
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve contacts for this company now!
Input
API Endpoint
Method
Request
Response
Create a new contact
Path Parameters
The ID of the company that owns this contact.
Post Body Parameters[Array]
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new contact now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all contacts
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
id
companyId
contactCode
firstName
middleName
lastName
title
line1
line2
line3
city
region
postalCode
country
phone
phone2
fax
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all contacts now!
Input
API Endpoint
Method
Request
Response
Retrieve the full list of Avalara-supported nexus for all countries and regions.
Response
The number of rows returned by your query, prior to pagination.
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve the full list of Avalara-supported nexus for all countries and regions. now!
Input
API Endpoint
Method
Response
Retrieve the full list of Avalara-supported nexus for a country.
Path Parameters
Response
The number of rows returned by your query, prior to pagination.
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve the full list of Avalara-supported nexus for a country. now!
Input
API Endpoint
Method
Request
Response
Retrieve the full list of Avalara-supported nexus for a country and region.
Path Parameters
The two-character ISO-3166 code for the country.
The two or three character region code for the region.
Response
The number of rows returned by your query, prior to pagination.
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve the full list of Avalara-supported nexus for a country and region. now!
Input
API Endpoint
Method
Request
Response
Retrieve the full list of Avalara-supported tax codes.
Response
The number of rows returned by your query, prior to pagination.
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve the full list of Avalara-supported tax codes. now!
Input
API Endpoint
Method
Response
Retrieve the full list of Avalara-supported subscription types
Response
The number of rows returned by your query, prior to pagination.
Id
Description
The link to the next page of results
Try Retrieve the full list of Avalara-supported subscription types now!
Input
API Endpoint
Method
Response
Retrieve a single filing calendar
Path Parameters
The ID of the company that owns this filing calendar
The primary key of this filing calendar
Response
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single filing calendar now!
Input
API Endpoint
Method
Request
Response
Update a single filing calendar
Path Parameters
The ID of the company that this filing calendar belongs to.
The ID of the filing calendar you wish to update
Post Body Parameters
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single filing calendar now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single filing calendar
Path Parameters
The ID of the company that owns this filing calendar.
The ID of the filing calendar you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single filing calendar now!
Input
API Endpoint
Method
Request
Response
Retrieve filing calendars for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these filing calendars
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve filing calendars for this company now!
Input
API Endpoint
Method
Request
Response
Create a new filing calendar
Path Parameters
The ID of the company that owns this filing calendar.
Post Body Parameters[Array]
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new filing calendar now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all filing calendars
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Return Name
If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
If this calendar is for a location-specific tax return, specify the location-specific behavior here.
Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
Filing Frequency Id
Months
Tax Registration ID for this Region - in the U.S., this is for your state.
Tax Registration ID for the local jurisdiction, if any.
Employer Identification Number
Line1
Line2
City
Region
Postal Code
Country
Phone
Customer Filing Instructions
Legal Entity Name
Effective Date
End Date
Filing Type Id
If you file electronically, this is the username you use to log in to the tax authority's website.
If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
Prepay Percentage
Tax Type Id
Internal Notes
Al Sign On
Al Access Code
Me Business Code
Ia Ben
Ct Reg
Other 1 Name
Other 1 Value
Other 2 Name
Other 2 Value
Other 3 Name
Other 3 Value
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all filing calendars now!
Input
API Endpoint
Method
Request
Response
Retrieve a single item
Path Parameters
The ID of the company that owns this item object
The primary key of this item
Response
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single item now!
Input
API Endpoint
Method
Request
Response
Update a single item
Path Parameters
The ID of the company that this item belongs to.
The ID of the item you wish to update
Post Body Parameters
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single item now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single item
Path Parameters
The ID of the company that owns this item.
The ID of the item you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single item now!
Input
API Endpoint
Method
Request
Response
Retrieve items for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these items
Response
The number of rows returned by your query, prior to pagination.
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve items for this company now!
Input
API Endpoint
Method
Request
Response
Create a new item
Path Parameters
The ID of the company that owns this item.
Post Body Parameters[Array]
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new item now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all items
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Item Code
Company Id
Tax Code Id
Tax Code
Description
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all items now!
Input
API Endpoint
Method
Request
Response
Retrieve a single location
Path Parameters
The ID of the company that owns this location
The primary key of this location
Response
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single location now!
Input
API Endpoint
Method
Request
Response
Update a single location
Path Parameters
The ID of the company that this location belongs to.
The ID of the location you wish to update
Post Body Parameters
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single location now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single location
Path Parameters
The ID of the company that owns this location.
The ID of the location you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single location now!
Input
API Endpoint
Method
Request
Response
Retrieve locations for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these locations
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve locations for this company now!
Input
API Endpoint
Method
Request
Response
Create a new location
Path Parameters
The ID of the company that owns this location.
Post Body Parameters[Array]
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new location now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all locations
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Location Code
Description
Address Type Id
Address Category Id
Line1
Line2
Line3
City
Region
Postal Code
Country
State Assigned Code
Is Default
County
Is Registered
Dba Name
Outlet Name
Start Date
End Date
Last Transaction Date
Registered Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all locations now!
Input
API Endpoint
Method
Request
Response
Retrieve a single nexus
Path Parameters
The ID of the company that owns this nexus object
The primary key of this nexus
Response
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single nexus now!
Input
API Endpoint
Method
Request
Response
Update a single nexus
Path Parameters
The ID of the company that this nexus belongs to.
The ID of the nexus you wish to update
Post Body Parameters
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single nexus now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single nexus
Path Parameters
The ID of the company that owns this nexus.
The ID of the nexus you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single nexus now!
Input
API Endpoint
Method
Request
Response
Retrieve nexus for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these nexus objects
Response
The number of rows returned by your query, prior to pagination.
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve nexus for this company now!
Input
API Endpoint
Method
Request
Response
Create a new nexus
Path Parameters
The ID of the company that owns this nexus.
Post Body Parameters[Array]
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new nexus now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all nexus
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
id
companyId
state
jurisTypeId
jurisCode
jurisName
effectiveDate
endDate
shortName
signatureCode
stateAssignedNo
nexusTypeId
country
sourcing
accountingMethodId
hasLocalNexus
localNexusTypeId
hasPermanentEstablishment
taxId
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all nexus now!
Input
API Endpoint
Method
Request
Response
Change Password
Post Body Parameters
Old Password
New Password
Try Change Password now!
Input
API Endpoint
Method
Request
{}
Response
Retrieve a single setting
Path Parameters
The ID of the company that owns this setting
The primary key of this setting
Response
Id
Company Id
Set
Name
Value
Try Retrieve a single setting now!
Input
API Endpoint
Method
Request
Response
Update a single setting
Path Parameters
The ID of the company that this setting belongs to.
The ID of the setting you wish to update
Post Body Parameters
Id
Company Id
Set
Name
Value
Response
Id
Company Id
Set
Name
Value
Try Update a single setting now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single setting
Path Parameters
The ID of the company that owns this setting.
The ID of the setting you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single setting now!
Input
API Endpoint
Method
Request
Response
Retrieve all settings for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these settings
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Set
Name
Value
The link to the next page of results
Try Retrieve all settings for this company now!
Input
API Endpoint
Method
Request
Response
Create a new setting
Path Parameters
The ID of the company that owns this setting.
Post Body Parameters[Array]
Id
Company Id
Set
Name
Value
Response[Array]
Id
Company Id
Set
Name
Value
Try Create a new setting now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all settings
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Company Id
Set
Name
Value
The link to the next page of results
Try Retrieve all settings now!
Input
API Endpoint
Method
Request
Response
Retrieve a single subscription
Path Parameters
The ID of the account that owns this subscription
The primary key of this subscription
Response
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single subscription now!
Input
API Endpoint
Method
Request
Response
Update a single subscription
Path Parameters
The ID of the account that this subscription belongs to.
The ID of the subscription you wish to update
Post Body Parameters
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single subscription now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single subscription
Path Parameters
The ID of the account that owns this subscription.
The ID of the subscription you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single subscription now!
Input
API Endpoint
Method
Request
Response
Retrieve subscriptions for this account
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the account that owns these subscriptions
Response
The number of rows returned by your query, prior to pagination.
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve subscriptions for this account now!
Input
API Endpoint
Method
Request
Response
Create a new subscription
Path Parameters
The ID of the account that owns this subscription.
Post Body Parameters[Array]
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new subscription now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all subscriptions
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all subscriptions now!
Input
API Endpoint
Method
Request
Response
Retrieve a single tax code
Path Parameters
The ID of the company that owns this tax code
The primary key of this tax code
Response
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single tax code now!
Input
API Endpoint
Method
Request
Response
Update a single tax code
Path Parameters
The ID of the company that this tax code belongs to.
The ID of the tax code you wish to update
Post Body Parameters
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single tax code now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single tax code
Path Parameters
The ID of the company that owns this tax code.
The ID of the tax code you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single tax code now!
Input
API Endpoint
Method
Request
Response
Retrieve tax codes for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these tax codes
Response
The number of rows returned by your query, prior to pagination.
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve tax codes for this company now!
Input
API Endpoint
Method
Request
Response
Create a new tax code
Path Parameters
The ID of the company that owns this tax code.
Post Body Parameters[Array]
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new tax code now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all tax codes
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
Tax Code
Tax Code Type Id
Company Id
Description
Parent Tax Code
Is Physical
Good Service Code
Entity Use Code
Is Active
Is SST Certified
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all tax codes now!
Input
API Endpoint
Method
Request
Response
Retrieve tax rates for a specified address
Querystring Parameters
The street address of the location.
The street address of the location.
The street address of the location.
The city name of the location.
The state or region of the location
The postal code of the location.
The two letter ISO-3166 country code.
Response
Total Rate
Rate
Name
Type
Try Retrieve tax rates for a specified address now!
Input
API Endpoint
Method
Request
Response
Retrieve tax rates for a specified country and postal code
Querystring Parameters
The two letter ISO-3166 country code.
The postal code of the location.
Response
Total Rate
Rate
Name
Type
Try Retrieve tax rates for a specified country and postal code now!
Input
API Endpoint
Method
Request
Response
Retrieve a single tax rule
Path Parameters
The ID of the company that owns this tax rule
The primary key of this tax rule
Response
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single tax rule now!
Input
API Endpoint
Method
Request
Response
Update a single tax rule
Path Parameters
The ID of the company that this tax rule belongs to.
The ID of the tax rule you wish to update
Post Body Parameters
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single tax rule now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single tax rule
Path Parameters
The ID of the company that owns this tax rule.
The ID of the tax rule you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single tax rule now!
Input
API Endpoint
Method
Request
Response
Retrieve tax rules for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these tax rules
Response
The number of rows returned by your query, prior to pagination.
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve tax rules for this company now!
Input
API Endpoint
Method
Request
Response
Create a new tax rule
Path Parameters
The ID of the company that owns this tax rule.
Post Body Parameters[Array]
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new tax rule now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all tax rules
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
CompanyId
State FIPS
Jurisdiction Name
Jurisdiction Code
Jurisdiction Type Id
Tax Code Id
Tax Code
Customer Usage Type
Tax Type Id
Rate Type Id
Tax Rule Type Id
Is All Juris
Value
Cap
Threshold
Options
Effective Date
End Date
Description
County FIPS
Is STPro
Country
Region
Sourcing
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all tax rules now!
Input
API Endpoint
Method
Request
Response
Retrieve a single transaction
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
Path Parameters
The company code of the company that recorded this transaction
The transaction code to retrieve
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Retrieve a single transaction now!
Input
API Endpoint
Method
Request
Response
Delete a single transaction
Path Parameters
The company code of the company that recorded this transaction
The transaction code to post
Response[Array]
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single transaction now!
Input
API Endpoint
Method
Request
Response
Retrieve all transactions
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The company code of the company that recorded this transaction
Response
The number of rows returned by your query, prior to pagination.
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
The link to the next page of results
Try Retrieve all transactions now!
Input
API Endpoint
Method
Request
Response
Correct a previously created transaction
Path Parameters
The company code of the company that recorded this transaction
The transaction code to adjust
Post Body Parameters
A reason code indicating why this adjustment was made
If the AdjustmentReason is "Other", specify the reason here
Company Code - The client application company reference code.
Document Type
Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.
Transaction Date - The date on the invoice, purchase order, etc.
Salesperson Code - The client application salesperson reference code.
Customer Code - The client application customer reference code.
Customer Usage Type - The client application customer or usage type.
Discount - The discount amount to apply to the document.
Purchase Order Number for this document
Exemption Number for this document
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line number within this document
Quantity of items in this line
Total amount for this line
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Tax Code - System or Custom Tax Code.
Customer Usage Type - The client application customer or usage type.
Item Code (SKU)
Exemption number for this line
True if the document discount should be applied to this line
Indicates if line has Tax Included; defaults to false
Revenue Account
Reference 1 - Client specific reference field
Reference 2 - Client specific reference field
Item description. This is required for SST transactions if an unmapped ItemCode is used.
BusinessIdentificationNo
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Reference Code used to reference the original document for a return invoice
The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.
Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
Causes the document to be committed if true.
BatchCode for batch operations.
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Indicates the tax effectivity override date for the entire document.
3 character ISO 4217 currency code.
Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)
Indicates the date payment was applied to this document. This is only for cash basis accounting.
Currency exchange rate from this transaction to the company base currency.
Effective date of the exchange rate.
Sets the POS Lane Code sent by the User for this document.
BusinessIdentificationNo
Specifies if the Transaction has the seller as IsSellerImporterOfRecord
Description
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Correct a previously created transaction now!
Input
API Endpoint
Method
Request
{ "newTransaction": { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "lines": [ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "taxOverride": {} } ], "taxOverride": {} } }
Response
Convert an invoice into a sale or purchase
Path Parameters
The company code of the company that recorded this transaction
The transaction code to commit
Post Body Parameters
If you wish to change the transaction code when committing the transaction, specify the new transaction code here.
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Convert an invoice into a sale or purchase now!
Input
API Endpoint
Method
Request
{}
Response
Cancel a transaction
Path Parameters
The company code of the company that recorded this transaction
The transaction code to cancel
Post Body Parameters
Please specify the reason for cancelling this transaction
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Cancel a transaction now!
Input
API Endpoint
Method
Request
{}
Response
Mark a transaction as posted to the ledger
Path Parameters
The company code of the company that recorded this transaction
The transaction code to post
Post Body Parameters
Transaction Date - The date on the invoice, purchase order, etc.
Total Amount - The total amount (not including tax) for the document.
Total Tax - The total tax for the document.
The hash code for the document.
Allows committing immediately rather than requiring a subsequent call to CommitTax.
If you wish to change the transaction code when committing the transaction, specify the new transaction code here.
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Mark a transaction as posted to the ledger now!
Input
API Endpoint
Method
Request
{}
Response
Create a new transaction
Path Parameters
The company code of the company that recorded these transactions
Post Body Parameters[Array]
Company Code - The client application company reference code.
Document Type
Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.
Transaction Date - The date on the invoice, purchase order, etc.
Salesperson Code - The client application salesperson reference code.
Customer Code - The client application customer reference code.
Customer Usage Type - The client application customer or usage type.
Discount - The discount amount to apply to the document.
Purchase Order Number for this document
Exemption Number for this document
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line number within this document
Quantity of items in this line
Total amount for this line
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Tax Code - System or Custom Tax Code.
Customer Usage Type - The client application customer or usage type.
Item Code (SKU)
Exemption number for this line
True if the document discount should be applied to this line
Indicates if line has Tax Included; defaults to false
Revenue Account
Reference 1 - Client specific reference field
Reference 2 - Client specific reference field
Item description. This is required for SST transactions if an unmapped ItemCode is used.
BusinessIdentificationNo
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Reference Code used to reference the original document for a return invoice
The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.
Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
Causes the document to be committed if true.
BatchCode for batch operations.
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Indicates the tax effectivity override date for the entire document.
3 character ISO 4217 currency code.
Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)
Indicates the date payment was applied to this document. This is only for cash basis accounting.
Currency exchange rate from this transaction to the company base currency.
Effective date of the exchange rate.
Sets the POS Lane Code sent by the User for this document.
BusinessIdentificationNo
Specifies if the Transaction has the seller as IsSellerImporterOfRecord
Description
Response[Array]
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Create a new transaction now!
Input
API Endpoint
Method
Request
[ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "lines": [ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "taxOverride": {} } ], "taxOverride": {} } ]
Response
Retrieve a single transaction
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
Path Parameters
The id of this transaction
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Retrieve a single transaction now!
Input
API Endpoint
Method
Request
Response
Delete a single transaction
Path Parameters
The ID of the transaction you wish to delete.
Response[Array]
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single transaction now!
Input
API Endpoint
Method
Request
Response
Correct a previously created transaction
Path Parameters
The ID of the transaction you wish to update
Post Body Parameters
A reason code indicating why this adjustment was made
If the AdjustmentReason is "Other", specify the reason here
Company Code - The client application company reference code.
Document Type
Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.
Transaction Date - The date on the invoice, purchase order, etc.
Salesperson Code - The client application salesperson reference code.
Customer Code - The client application customer reference code.
Customer Usage Type - The client application customer or usage type.
Discount - The discount amount to apply to the document.
Purchase Order Number for this document
Exemption Number for this document
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line number within this document
Quantity of items in this line
Total amount for this line
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Tax Code - System or Custom Tax Code.
Customer Usage Type - The client application customer or usage type.
Item Code (SKU)
Exemption number for this line
True if the document discount should be applied to this line
Indicates if line has Tax Included; defaults to false
Revenue Account
Reference 1 - Client specific reference field
Reference 2 - Client specific reference field
Item description. This is required for SST transactions if an unmapped ItemCode is used.
BusinessIdentificationNo
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Reference Code used to reference the original document for a return invoice
The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.
Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
Causes the document to be committed if true.
BatchCode for batch operations.
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Indicates the tax effectivity override date for the entire document.
3 character ISO 4217 currency code.
Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)
Indicates the date payment was applied to this document. This is only for cash basis accounting.
Currency exchange rate from this transaction to the company base currency.
Effective date of the exchange rate.
Sets the POS Lane Code sent by the User for this document.
BusinessIdentificationNo
Specifies if the Transaction has the seller as IsSellerImporterOfRecord
Description
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Correct a previously created transaction now!
Input
API Endpoint
Method
Request
{ "newTransaction": { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "lines": [ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "taxOverride": {} } ], "taxOverride": {} } }
Response
Convert an invoice into a sale or purchase
Path Parameters
The ID of the transaction you wish to update
Post Body Parameters
If you wish to change the transaction code when committing the transaction, specify the new transaction code here.
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Convert an invoice into a sale or purchase now!
Input
API Endpoint
Method
Request
{}
Response
Cancel a transaction
Path Parameters
The ID of the transaction you wish to update
Post Body Parameters
Please specify the reason for cancelling this transaction
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Cancel a transaction now!
Input
API Endpoint
Method
Request
{}
Response
Mark a transaction as posted to the ledger
Path Parameters
The ID of the transaction you wish to update
Post Body Parameters
Transaction Date - The date on the invoice, purchase order, etc.
Total Amount - The total amount (not including tax) for the document.
Total Tax - The total tax for the document.
The hash code for the document.
Allows committing immediately rather than requiring a subsequent call to CommitTax.
If you wish to change the transaction code when committing the transaction, specify the new transaction code here.
Response
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Mark a transaction as posted to the ledger now!
Input
API Endpoint
Method
Request
{}
Response
Create a new transaction
Post Body Parameters[Array]
Company Code - The client application company reference code.
Document Type
Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.
Transaction Date - The date on the invoice, purchase order, etc.
Salesperson Code - The client application salesperson reference code.
Customer Code - The client application customer reference code.
Customer Usage Type - The client application customer or usage type.
Discount - The discount amount to apply to the document.
Purchase Order Number for this document
Exemption Number for this document
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line number within this document
Quantity of items in this line
Total amount for this line
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Line1
Line2
Line3
City
State / Province / Region
Two character ISO 3166 Country Code
Postal Code / Zip Code
Geospatial latitude measurement
Geospatial longitude measurement
Tax Code - System or Custom Tax Code.
Customer Usage Type - The client application customer or usage type.
Item Code (SKU)
Exemption number for this line
True if the document discount should be applied to this line
Indicates if line has Tax Included; defaults to false
Revenue Account
Reference 1 - Client specific reference field
Reference 2 - Client specific reference field
Item description. This is required for SST transactions if an unmapped ItemCode is used.
BusinessIdentificationNo
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Reference Code used to reference the original document for a return invoice
The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.
Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
Causes the document to be committed if true.
BatchCode for batch operations.
Identifies the type of tax override
Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.
The override tax date to use
This provides the reason for a tax override for audit purposes. It is required for types 2-4.
Indicates the tax effectivity override date for the entire document.
3 character ISO 4217 currency code.
Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)
Indicates the date payment was applied to this document. This is only for cash basis accounting.
Currency exchange rate from this transaction to the company base currency.
Effective date of the exchange rate.
Sets the POS Lane Code sent by the User for this document.
BusinessIdentificationNo
Specifies if the Transaction has the seller as IsSellerImporterOfRecord
Description
Response[Array]
DocumentId
DocumentCode
DocumentDate
TaxDate
PaymentDate
DocumentStatusId
DocumentTypeId
CompanyId
BatchCode
CurrencyCode
CustomerUsageType
CustomerVendorCode
ExemptNo
IsReconciled
LocationCode
PurchaseOrderNo
ReferenceCode
SalespersonCode
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TotalAmount
TotalExempt
TotalTax
TotalTaxable
TotalTaxCalculated
AdjustmentReasonId
AdjustmentDescription
IsLocked
Region
Country
Version
SoftwareVersion
OriginAddressId
DestinationAddressId
ExchangeRateEffDate
ExchangeRate
IsSellerImporterOfRecord
Description
BRBuyerType
BRBuyer_IsExemptOrCannotWH_IRRF
BRBuyer_IsExemptOrCannotWH_PISRF
BRBuyer_IsExemptOrCannotWH_COFINSRF
BRBuyer_IsExemptOrCannotWH_CSLLRF
BRBuyer_IsExempt_PIS
BRBuyer_IsExempt_COFINS
BRBuyer_IsExempt_CSLL
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
DocumentLineId
DocumentId
LineNo
AccountingMethodId
BoundaryOverrideId
CustomerUsageType
Description
DestinationAddressId
DiscountAmount
DiscountTypeId
ExemptAmount
ExemptCertId
ExemptNo
IsItemTaxable
IsSSTP
ItemCode
LineAmount
OriginAddressId
Quantity
Ref1
Ref2
ReportingDate
RevAccount
Sourcing
Tax
TaxableAmount
TaxCalculated
TaxCode
TaxCodeId
TaxDate
TaxEngine
TaxOverrideTypeId
TaxOverrideAmount
TaxOverrideReason
TaxIncluded
DocumentLineDetailId
DocumentLineId
DocumentId
AddressId
Country
Region
CountyFips
StateFips
ExemptAmount
ExemptReasonId
InState
JurisCode
JurisName
JurisdictionId
JurisTypeId
NonTaxableAmount
NonTaxableRuleId
NonTaxableTypeId
Rate
RateRuleId
RateSourceId
SignatureCode
SERCode
Sourcing
StateAssignedNo
Tax
TaxableAmount
TaxTypeId
TaxName
TaxAuthorityTypeId
TaxRegionId
TaxCalculated
TaxOverride
RateTypeId
DocumentAddressId
DocumentId
BoundaryLevel
AddressLine1
AddressLine2
AddressLine3
City
Region
PostalCode
Country
TaxRegionId
Try Create a new transaction now!
Input
API Endpoint
Method
Request
[ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "lines": [ { "addresses": { "Unknown": {}, "ShipFrom": {}, "ShipTo": {}, "PointOfOrderAcceptance": {}, "PointOfOrderOrigin": {}, "SingleLocation": {}, "Other": {} }, "taxOverride": {} } ], "taxOverride": {} } ]
Response
Retrieve a single UPC
Path Parameters
The ID of the company that owns this UPC
The primary key of this UPC
Response
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single UPC now!
Input
API Endpoint
Method
Request
Response
Update a single UPC
Path Parameters
The ID of the company that this UPC belongs to.
The ID of the UPC you wish to update
Post Body Parameters
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single UPC now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single UPC
Path Parameters
The ID of the company that owns this UPC.
The ID of the UPC you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single UPC now!
Input
API Endpoint
Method
Request
Response
Retrieve UPCs for this company
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The ID of the company that owns these UPCs
Response
The number of rows returned by your query, prior to pagination.
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve UPCs for this company now!
Input
API Endpoint
Method
Request
Response
Create a new UPC
Path Parameters
The ID of the company that owns this UPC.
Post Body Parameters[Array]
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response[Array]
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new UPC now!
Input
API Endpoint
Method
Request
[ {} ]
Response
Retrieve all UPCs
Querystring Parameters
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
Id
CompanyId
UPC
Legacy Tax Code
Description
Effective Date
End Date
Usage
IsSystem
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all UPCs now!
Input
API Endpoint
Method
Request
Response
Retrieve a single user
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
Path Parameters
The ID of the user to retrieve.
The accountID of the user you wish to get.
Response
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Retrieve a single user now!
Input
API Endpoint
Method
Request
Response
Update a single user
Path Parameters
The ID of the user you wish to update.
The accountID of the user you wish to update.
Post Body Parameters
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
Id
Name
Effective Date
End Date
Account Status Id
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Id
Account Id
Subscription Type Id
Subscription Description
Effective Date
End Date
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Update a single user now!
Input
API Endpoint
Method
Request
{}
Response
Delete a single user
Path Parameters
The ID of the user you wish to delete.
The accountID of the user you wish to delete.
Response
Category of the error
Short one-line message to summaryize what went wrong
What object or service caused the error?
Error message identifier
Concise summary of the message
Message details
Indicates the SoapFault code
URL to help for this message
Name of the message.
Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
Severity of the message
Source of the message
Documentation of the message
Try Delete a single user now!
Input
API Endpoint
Method
Request
Response
Retrieve users for this account
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Path Parameters
The accountID of the user you wish to list.
Response
The number of rows returned by your query, prior to pagination.
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve users for this account now!
Input
API Endpoint
Method
Request
Response
Create a new user
Path Parameters
The accountID of the user you wish to create.
Post Body Parameters
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Response
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
Try Create a new user now!
Input
API Endpoint
Method
Request
{}
Response
Retrieve all users
Querystring Parameters
A comma separated list of child objects to return underneath the primary object.
A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
If nonzero, return no more than this number of results.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.
Response
The number of rows returned by your query, prior to pagination.
id
accountId
userName
firstName
lastName
postalCode
securityRoleId
companyId
passwordStatus
isActive
The date when this record was created (read only)
The User ID of the user who created this record (read only)
The date/time when this record was last modified (read only)
The user ID of the user who last modified this record (read only)
The link to the next page of results
Try Retrieve all users now!
Input
API Endpoint
Method
Request
Response
Retrieve all entitlements for a single user
Path Parameters
The ID of the user to retrieve.
The accountID of the user you wish to get.
Response
Company
Try Retrieve all entitlements for a single user now!
Input
API Endpoint
Method
Request
Response
Tests connectivity and version of the service
Response
Version number